<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class IQueryResult</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface IQueryResult</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Represents the result of a query. The query result contains</p>
<p class="description"><p>query transformations (changed performed on the original query before  submission) and the document summaries of the documents matching the  query. The query transformations contain feedback from query transformers  such as spell check and proper name If the initial query resulted in zero  hits and the search parameter resubmitflags was set when searching, the query  result will contain two query transformations. The query transformations  feedback for the initial query performed is returned by calling  <a href="../sde_fastsearch_result/IQueryResult.html#methodgetQueryTransformations">getQueryTransformations</a>(false). The feedback for the resubmitted query  is retreived by calling <a href="../sde_fastsearch_result/IQueryResult.html#methodgetQueryTransformations">getQueryTransformations</a>(true). If the initial  query results in hits or resubmitflags is not set, only one query  transformations will be returned. Retreived by calling  <a href="../sde_fastsearch_result/IQueryResult.html#methodgetQueryTransformations">getQueryTransformations</a>(false)</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Andreas Scheerer &lt;<a href="mailto:Andreas.Scheerer@sueddeutsche.de">Andreas.Scheerer@sueddeutsche.de</a>&gt;</li>
				<li><span class="field">version:</span> $Id: IQueryResult.html 14 2009-08-23 04:31:36Z andreas.scheerer $</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_src---sde---fastsearch---result---IQueryResult.php.html">/src/sde/fastsearch/result/IQueryResult.php</a> (line <span class="field">45</span>)
		</p>
		
				
		<pre><a href="../sde_fastsearch_result/IResultObject.html">IResultObject</a>
   |
   --IQueryResult</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																														
				<div class="method-definition">
											<span class="method-result">Iterator</span>
										<a href="#documents" title="details" class="method-name">documents</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getDocCount" title="details" class="method-name">getDocCount</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_result/IDocumentSummary.html">IDocumentSummary</a></span>
										<a href="#getDocument" title="details" class="method-name">getDocument</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$index</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getHttpSearchURL" title="details" class="method-name">getHttpSearchURL</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">float</span>
										<a href="#getMaxRank" title="details" class="method-name">getMaxRank</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_query/IQuery.html">IQuery</a></span>
										<a href="#getOriginalQuery" title="details" class="method-name">getOriginalQuery</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getQueryTransformations" title="details" class="method-name">getQueryTransformations</a>
											([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$resubmitted</span> = <span class="var-default">false</span>])
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getSegmentName" title="details" class="method-name">getSegmentName</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">float</span>
										<a href="#getTimeUsed" title="details" class="method-name">getTimeUsed</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#navigatorCount" title="details" class="method-name">navigatorCount</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">Iterator</span>
										<a href="#navigators" title="details" class="method-name">navigators</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#__toString" title="details" class="method-name">__toString</a>
										()
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methoddocuments" id="documents"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">documents</span> (line <span class="line-number">51</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a list iterator for the document summaries in this query result.</p>
	<ul class="tags">
				<li><span class="field">return:</span> iterator of document summaries in this query result.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Iterator</span>
		<span class="method-name">
			documents
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetDocCount" id="getDocCount"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getDocCount</span> (line <span class="line-number">65</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the number of hits/documents this query resulted in.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getDocCount
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetDocument" id="getDocument"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getDocument</span> (line <span class="line-number">73</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the document summary at the given position.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_result/IDocumentSummary.html">IDocumentSummary</a></span>
		<span class="method-name">
			getDocument
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$index</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$index</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetHttpSearchURL" id="getHttpSearchURL"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getHttpSearchURL</span> (line <span class="line-number">124</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the http search request url in case of the use  of a http search engine. implemented for debugging reasons.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getHttpSearchURL
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetMaxRank" id="getMaxRank"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getMaxRank</span> (line <span class="line-number">81</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">An estimated value indicating the maximum possible ranking value for the  current search.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">float</span>
		<span class="method-name">
			getMaxRank
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetOriginalQuery" id="getOriginalQuery"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getOriginalQuery</span> (line <span class="line-number">58</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the original query.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_query/IQuery.html">IQuery</a></span>
		<span class="method-name">
			getOriginalQuery
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetQueryTransformations" id="getQueryTransformations"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getQueryTransformations</span> (line <span class="line-number">102</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the query transformations in form of an <a href="../sde_fastsearch_result/IQueryTransformations.html">IQueryTransformations</a>  instance.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getQueryTransformations
		</span>
					([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$resubmitted</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$resubmitted</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetSegmentName" id="getSegmentName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getSegmentName</span> (line <span class="line-number">95</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the name of the search segment from which these query results came.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getSegmentName
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetTimeUsed" id="getTimeUsed"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getTimeUsed</span> (line <span class="line-number">88</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the time used by the search engine to perform the query.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">float</span>
		<span class="method-name">
			getTimeUsed
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodnavigatorCount" id="navigatorCount"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">navigatorCount</span> (line <span class="line-number">109</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the number of navigators.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			navigatorCount
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodnavigators" id="navigators"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">navigators</span> (line <span class="line-number">116</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an iterator for the navigators in this query result.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Iterator</span>
		<span class="method-name">
			navigators
		</span>
				()
			</div>
	
		
			
	</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">__toString</span> (line <span class="line-number">131</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a string representing the query result.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			__toString
		</span>
				()
			</div>
	
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../sde_fastsearch_result/IResultObject.html">IResultObject</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../sde_fastsearch_result/IResultObject.html#methodprepareUnset">IResultObject::prepareUnset()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 23 Aug 2009 06:30:08 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>